Cleanup retrySendTimeout func creation by esimkowitz · Pull Request #1872 · wavetermdev/waveterm

esimkowitz · 2025-01-29T21:31:13Z

No description provided.

coderabbitai · 2025-01-29T21:31:22Z

Walkthrough

The pull request introduces a refactoring change in the retrySendTimeout function within the pkg/wshutil/wshrpc.go file. The modification involves restructuring the implementation of a done function from an inline, immediately invoked function to a standalone function that is called within a loop.

The core logic of the function remains consistent, with the primary change being the extraction and separation of the function definition. The refactored implementation maintains the original behavior of attempting to send a resId to the CtxDoneCh while checking if the server is done. This change aims to improve code readability and potentially enhance the function's modularity by defining the done function separately from its execution context.

The overall functionality of the retrySendTimeout method is preserved, ensuring that the method continues to operate as it did before the refactoring.

✨ Finishing Touches

📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

pkg/wshutil/wshrpc.go (1)

748-752: Consider adding a maximum retry limit.

While the current implementation works, it could potentially run indefinitely if the channel remains full and the server isn't done. Consider adding a maximum retry limit or an exponential backoff strategy.

+       maxRetries := 50 // 5 seconds total (50 * 100ms)
+       retryCount := 0
        for {
                if done() {
                        return
                }
+               retryCount++
+               if retryCount >= maxRetries {
+                       log.Printf("Failed to send timeout after %d attempts for resId: %s", maxRetries, resId)
+                       return
+               }
                time.Sleep(100 * time.Millisecond)
        }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8bf6755 and 27376e9.

📒 Files selected for processing (1)

pkg/wshutil/wshrpc.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Analyze (javascript-typescript)
GitHub Check: Build for TestDriver.ai
GitHub Check: Analyze (go)

🔇 Additional comments (1)

pkg/wshutil/wshrpc.go (1)

735-747: LGTM! Clean and thread-safe implementation.

The done function is well-structured with proper lock handling and clear control flow. The implementation correctly handles both server termination and channel send attempts.

Cleanup retrySendTimeout

27376e9

coderabbitai bot reviewed Jan 29, 2025

View reviewed changes

esimkowitz merged commit a8dd0b7 into main Jan 31, 2025
8 checks passed

esimkowitz deleted the evan/retrySendTimeout branch January 31, 2025 01:33

xxyy2024 pushed a commit to xxyy2024/waveterm_aipy that referenced this pull request Jun 24, 2025

Cleanup retrySendTimeout func creation (wavetermdev#1872)

fcc2b1d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Cleanup retrySendTimeout func creation#1872

Cleanup retrySendTimeout func creation#1872
esimkowitz merged 1 commit intomainfrom
evan/retrySendTimeout

esimkowitz commented Jan 29, 2025

Uh oh!

coderabbitai bot commented Jan 29, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

esimkowitz commented Jan 29, 2025

Uh oh!

coderabbitai bot commented Jan 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

coderabbitai bot commented Jan 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)